Add `prefer-import-meta-properties` rule #2607

ota-meshi · 2025-03-26T10:30:13Z

This PR adds prefer-import-meta-properties rule that reports the following code:

import path from "path";
import { fileURLToPath } from "url";
const dirname1 = path.dirname(fileURLToPath(import.meta.url));
const dirname2 = path.dirname(import.meta.filename);
const dirname3 = fileURLToPath(new URL(".", import.meta.url));
const filename1 = fileURLToPath(import.meta.url);
const filename2 = fileURLToPath(new URL(import.meta.url));

close #2255

ota-meshi · 2025-03-26T13:28:09Z

I realized that new URL(".", import.meta.url).pathname shouldn't be reported because it can be used in the browser.
I'll change this PR.

ota-meshi · 2025-03-26T13:40:47Z

I have changed this PR.

fisker · 2025-03-26T16:38:32Z

I realized that new URL(".", import.meta.url).pathname shouldn't be reported because it can be used in the browser. I'll change this PR.

new URL("./", import.meta.url).pathname should use the same logic.

ota-meshi · 2025-03-26T23:51:24Z

Thank you!
I changed it to check new URL("./", ...) as well.

test/prefer-module.js

fisker · 2025-03-27T09:08:35Z

rules/prefer-module.js

+			const fix = fixer =>
+				fixer.replaceText(node, `import.meta.${name}`);
+
+			if (filename.endsWith('.mjs')) {


Should import.meta already ensure these files are in ESM? Why this check needed?

Should we give the community some time to drop Node.js 18, and add an option instead?

Oh, you're right, no need to check for mjs 😓
It's definitely an ESM because it already uses import.meta.
I'll change that.

Should we give the community some time to drop Node.js 18, and add an option instead?

With Node v18 reaching EOL next month, I'm not sure if it should be an option 😅

#2255 (comment)

rules/prefer-module.js

ota-meshi · 2025-03-27T12:36:59Z

Thank you for your review!
I have made some changes to this PR.

fisker

@ota-meshi Please take a look

rules/prefer-module.js

ota-meshi · 2025-03-29T08:31:33Z

Thank you for reviewing this PR!
I've made some changes to this PR, could you please check it again?

fisker · 2025-03-29T13:36:54Z

Pushed some commits, most of them are making all kinds of check stricter and improve readability.

fisker · 2025-03-29T13:46:03Z

Due to bug in iterateProblemsFromFilename, I found a broken case 7816928 , can you fix?

ota-meshi · 2025-03-29T14:33:22Z

I think it's the same test case as L406, and I think it's intentional. Any suggestions on how to fix it 🤔

fisker · 2025-03-29T19:48:57Z

I think it's the same test case as L406, and I think it's intentional. Any suggestions on how to fix it 🤔

Sorry, I was wrong about it.

fisker · 2025-03-29T20:01:23Z

Everything looks good to me, except one thing.

Do you think it's possible that we break this case?

const x = new URL(import.meta.url).pathname
const filename = isWindows() ? x.slice(1) :x

Since new URL('file:///C:/file').pathname is actually /C:/file, not C:/file

fisker · 2025-03-29T20:15:52Z

Also, about this

Should we give the community some time to drop Node.js 18, and add an option instead?

Your answer make sense to me

With Node v18 reaching EOL next month, I'm not sure if it should be an option 😅

But I don't want people to disable this rule only because their target environment doesn't have import.meta.{dirname,filename}.

Personally, I even prefer add this PR as a separate rule, this part also not technically "prefer-module".

import.meta maybe also keep adding new stuff, having a separate rule should be easier to maintain.

@sindresorhus What do you think?

ota-meshi · 2025-03-30T01:34:17Z

Since new URL('file:///C:/file').pathname is actually /C:/file, not C:/file

Thank you for your comment, I didn't know it would return different results for Windows paths 😅
I will change it to not report .pathname.

ota-meshi · 2025-03-31T06:12:36Z

Personally, I even prefer add this PR as a separate rule, this part also not technically "prefer-module".

By the way, originally I wanted a rule to be added to convert path.dirname(fileURLToPath(import.meta.url)) to import.meta.dirname. I searched for similar issues in this repository and found #2255, so I implemented it in prefer-module and opened a PR.
It's useful for me either in the prefer-module rule or in another rule 😄

sindresorhus · 2025-03-31T06:26:06Z

It could be a separate rule, but isn't it easier just to keep it in here under an option? We still want this rule to enforce not using __dirname, and we want a fix-it for that, and that fix it should ideally be import.meta.dirname (when an option is enabled). So while a different rule could handle the fileURLToPath(import.meta.url) and path.dirname(import.meta.filename) case. It just seems easier to have it all here.

fisker · 2025-03-31T07:38:40Z

__dirname

We already provide both
import.meta.dirname and path.dirname(url.fileURLToPath(import.meta.url)) as suggestion.

If the new rule enabled, it doesn't matter which one user choose, user will end up using import.meta.dirname.

Since you are not against seperate rule, let's do it.

My suggestion for rule name is prefer-import-meta-properties.

ota-meshi · 2025-03-31T07:41:36Z

My suggestion for rule name is prefer-import-meta-properties.

👍

I will change this PR to add the new rule.

fisker

Good job! Thank you!

ota-meshi added 6 commits March 26, 2025 19:24

prefer-module: Support import.meta.{dirname,filename}

c2a6c45

chore: fix linting errors

0bc4a01

chore: revert test/unit/get-documentation-url.js

7107b20

feat: check for filename vars

9e1bff8

test: fix comment

fd842aa

docs: add import.meta.{dirname,filename}

93c7dac

fix: allow new URL() operations

e098150

fix: support for new URL('./', ...) and add tests

d54ee2a

fix: update error messages

e82b019

fisker reviewed Mar 27, 2025

View reviewed changes

test/prefer-module.js Outdated Show resolved Hide resolved

fisker reviewed Mar 27, 2025

View reviewed changes

rules/prefer-module.js Outdated Show resolved Hide resolved

ota-meshi added 3 commits March 27, 2025 18:25

change to always auto-fix

948e222

split test cases

c510e0c

support process.getBuiltinModule()

d7d508c

fisker requested changes Mar 28, 2025

View reviewed changes

use ast utils and some refactor

859a275

fisker added 7 commits March 29, 2025 20:24

Fix style

c600810

Ignore computed and optional

bfdbd2d

Strict Property check

c4dba43

Code style

d21168a

Test other MetaProperty

f611d8a

Stricter property access

5df79f1

Minor tweak

5852350

fisker added 6 commits March 29, 2025 21:15

Stricter check url.fileURLToPath and path.dirname

d490f06

Function renaming

2908767

Rename and comments

0bb4574

Revert rename, misunderstanding

b6a0b54

Remove misleading targetNode

3ccba73

Comment tweak

f97138d

Broken case

7816928

fisker added 2 commits March 30, 2025 03:46

False alarm

c3bcf1c

One more test

e953258

ignore URL.pathname

a2f4442

ota-meshi added 2 commits March 31, 2025 17:27

add prefer-import-meta-properties, and revert prefer-module

259c6f8

docs: fix docs

f9b359f

ota-meshi changed the title ~~prefer-module: Support import.meta.{dirname,filename}~~ Add prefer-import-meta-properties rule Mar 31, 2025

update eslint.dogfooding.config.js

f790666

fisker approved these changes Mar 31, 2025

View reviewed changes

fisker and others added 2 commits March 31, 2025 16:55

Minor tweak

50f05e8

Update prefer-import-meta-properties.md

701d27d

sindresorhus merged commit 1f6e172 into sindresorhus:main Mar 31, 2025
17 checks passed

ota-meshi deleted the prefer-module-import-meta branch March 31, 2025 10:47

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add `prefer-import-meta-properties` rule #2607

Add `prefer-import-meta-properties` rule #2607

ota-meshi commented Mar 26, 2025 •

edited

Loading

ota-meshi commented Mar 26, 2025

ota-meshi commented Mar 26, 2025

fisker commented Mar 26, 2025 •

edited

Loading

ota-meshi commented Mar 26, 2025

fisker Mar 27, 2025

fisker Mar 27, 2025

ota-meshi Mar 27, 2025

ota-meshi Mar 27, 2025 •

edited

Loading

ota-meshi commented Mar 27, 2025

fisker left a comment

ota-meshi commented Mar 29, 2025

fisker commented Mar 29, 2025

fisker commented Mar 29, 2025

ota-meshi commented Mar 29, 2025

fisker commented Mar 29, 2025

fisker commented Mar 29, 2025

fisker commented Mar 29, 2025 •

edited

Loading

ota-meshi commented Mar 30, 2025

ota-meshi commented Mar 31, 2025

sindresorhus commented Mar 31, 2025

fisker commented Mar 31, 2025 •

edited

Loading

ota-meshi commented Mar 31, 2025

fisker left a comment

Add prefer-import-meta-properties rule #2607

Add prefer-import-meta-properties rule #2607

Conversation

ota-meshi commented Mar 26, 2025 • edited Loading

ota-meshi commented Mar 26, 2025

ota-meshi commented Mar 26, 2025

fisker commented Mar 26, 2025 • edited Loading

ota-meshi commented Mar 26, 2025

fisker Mar 27, 2025

Choose a reason for hiding this comment

fisker Mar 27, 2025

Choose a reason for hiding this comment

ota-meshi Mar 27, 2025

Choose a reason for hiding this comment

ota-meshi Mar 27, 2025 • edited Loading

Choose a reason for hiding this comment

ota-meshi commented Mar 27, 2025

fisker left a comment

Choose a reason for hiding this comment

ota-meshi commented Mar 29, 2025

fisker commented Mar 29, 2025

fisker commented Mar 29, 2025

ota-meshi commented Mar 29, 2025

fisker commented Mar 29, 2025

fisker commented Mar 29, 2025

fisker commented Mar 29, 2025 • edited Loading

ota-meshi commented Mar 30, 2025

ota-meshi commented Mar 31, 2025

sindresorhus commented Mar 31, 2025

fisker commented Mar 31, 2025 • edited Loading

ota-meshi commented Mar 31, 2025

fisker left a comment

Choose a reason for hiding this comment

Add `prefer-import-meta-properties` rule #2607

Add `prefer-import-meta-properties` rule #2607

ota-meshi commented Mar 26, 2025 •

edited

Loading

fisker commented Mar 26, 2025 •

edited

Loading

ota-meshi Mar 27, 2025 •

edited

Loading

fisker commented Mar 29, 2025 •

edited

Loading

fisker commented Mar 31, 2025 •

edited

Loading